Skip to content

docs(remix): Add the Remix 3 alpha setup page - #19773

Merged
chargome merged 3 commits into
masterfrom
charlygomez/js-3777-remix-3-alpha-docs
Oct 2, 2026
Merged

chargome merged 3 commits into
masterfrom
charlygomez/js-3777-remix-3-alpha-docs

Conversation

@chargome

@chargome chargome commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Adds a setup page for the Remix 3 support that @sentry/remix ships under its /v3 subpaths: the --import entry that replaces remix/node-tsx, the two init() calls, the allowPackages and define additions to the asset server, the source map upload command, and the warning the SDK prints when the instrumentation did not apply. Marked alpha, API can change.

The Remix guide's "not yet supported" alert now points to it.

Do not merge before the SDK alpha is published. SDK PRs: getsentry/sentry-javascript#24943, getsentry/sentry-javascript#24968. Refs getsentry/sentry-javascript#24687.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@chargome chargome self-assigned this Oct 2, 2026
@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 2, 2026 11:55am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 2, 2026 11:55am UTC

Request Review

@linear-code

linear-code Bot commented Oct 2, 2026

Copy link
Copy Markdown

JS-3777

Show the minimal invocation and move the optional flags into prose. The
org, project and auth token are read from the environment and the release
is proposed from git, so none of them need to be on the command line.

Drop the troubleshooting section, that part was never shipped.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The command does not read the project from SENTRY_PROJECT.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@chargome
chargome marked this pull request as ready for review October 2, 2026 11:52
@chargome
chargome requested review from nicohrubec and s1gr1d October 2, 2026 11:52
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 2, 2026 11:52
@cursor

cursor Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Rollouts skipped this pull request: Documentation-only changes (Markdown and docs site MDX files).

Mention @change-monitor in a comment to monitor it anyway.


Call `init()` in your server entry.

Each request gets a span named after the matched route pattern. Errors thrown in route handlers, middleware and the request listener are reported. Requests the client aborted are not, and neither are thrown responses with a status from 300 to 499. Pass `shouldHandleError` to `remixV3Integration()` to change that.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a callback, right?

Suggested change
Each request gets a span named after the matched route pattern. Errors thrown in route handlers, middleware and the request listener are reported. Requests the client aborted are not, and neither are thrown responses with a status from 300 to 499. Pass `shouldHandleError` to `remixV3Integration()` to change that.
Each request gets a span named after the matched route pattern. Errors thrown in route handlers, middleware and the request listener are reported. Requests the client aborted are not, and neither are thrown responses with a status from 300 to 499. Pass your custom function in `shouldHandleError` to `remixV3Integration()` to change that.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but it comes with a default already

@chargome
chargome merged commit 5539629 into master Oct 2, 2026
25 checks passed
@chargome
chargome deleted the charlygomez/js-3777-remix-3-alpha-docs branch October 2, 2026 12:59
chargome added a commit that referenced this pull request Oct 5, 2026
## DESCRIBE YOUR PR

Follow-up to #19773, which is already merged. Updates the Remix 3 alpha
page for Remix 3.0.0:

- The install step asks for Remix 3.0.0 or later instead of
`remix@3.0.0-rc.1`.
- The browser entry imports `run` from `remix/component`, since 3.0.0
renamed `@remix-run/ui` to `@remix-run/component`.

Nothing else changes. The import map setup (`getScriptEntry`,
`<ImportMap>`) that 3.0.0 requires is a Remix change every app makes and
is documented by Remix, so it stays out of this page, which only shows
the Sentry additions. The server snippet, the asset server snippet and
the upload section are unchanged.

Stays a draft until the SDK alpha with the 3.0.0 fix is published. Refs
getsentry/sentry-javascript#25008.

## IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
Select exactly one option. For deadlines, replace `YYYY-MM-DD` with the
due date. You can update this information later by editing the PR
description.

- [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD
- [ ] Other deadline: YYYY-MM-DD
- [x] No deadline: Not urgent, can wait up to 1 week+

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
supplied a deadline.

Thanks in advance for your help!

## PRE-MERGE CHECKLIST

_Make sure you've checked the following before merging your changes:_

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — bb267e16 Deployed Oct 2, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants